AnimalsHUD
==========


ANLEITUNG

Ursprüngliche Version:

-- Mod: Animals Hud
-- Author: xDeekay
-- xDeekay
-- @Date: 17.12.2018
-- @Update 3.4.0.0 Date: 20.06.2019
-- @Version: 3.4.0.0 
-- Copyright (C) xDeekay, All Rights Reserved.

+++

weiterentwickelt von: Michel
Version: 3.4.0.1  Michel

================================================================================================================

Der Mod AnimalsHUD von xDeekay wurde im November 2019 von mir weiterentwickelt.

WICHTIG: Die ursprüngliche Version war NICHT Seasons-kompatibel. Dies wurde nun als Option implementiert. In den
Zeilen 29 und 30 kann man auswählen, ob die Mods 'Seasons' und 'MoreBunkerSilo' genutzt werden. Hier muss korrekt
'true' oder 'false' eingetragen werden, da diese Mods die Zusammensetzung des benötigten/möglichen Tierfutters
beeinflussen. Sind diese Variablen nicht korrekt gesetzt kommt es zu LUA-Fehlern bzw. falschen Anzeigewerten, da
das Programm sonst ungültige Variablen abfragt (Seasons) bzw. Futterstände falsch berechnet (MoreBunkerSilo).

Hinweis 1: Die Lauffähigkeit OHNE Seasons und/oder OHNE MoreBunkerSilo wurde NICHT AUSGIEBIG getestet.
Hinweis 2: Die angezeigte Reihefolge der Ställe innerhalb einer Tierart scheint duch LS zufällig zu erfolgen.

+++

Änderungen

- Texte in der Tastaturbelegung definiert (de/en)
- neue Anzeige-Funktionen (siehe auch Tastaturbelegung bzw. Anzeigemodi)
- optimierte Schriftfarben
- farbige Hintergründe zur besseren Lesbarkeit und Unterscheidung (derzeit fest eine Farbe pro Tier)
- Schriftgröße: feinere Abstufung möglich, begrenzt auf klein bis groß (aber nicht mehr winzig bis reisig)
- Tierlogos neben den HUD-Abschnitten (dynamische Größenänderung mit der Schriftgröße)
- Auswahl der Tierlogos
- dynamische Größenanpassung der HUD (Länge und Breite)
- HUD plazierbar über Variablen in der Datei animalsuds.lua
- in fest verbauten Hühnerställen baut Seasons KEIN Wasser ein; dennoch wird jetzt eine Zeile 'Wasser ----' angezeigt, damit das bei allen Ställen gleich aussieht
- erweiterte Speicherung der individuellen Konfiguration (Anzeigetyp kombiniert/Breite/Länge, Tierlogos inkl. Transparenz)

- BugFix: Es gibt eine Diskrepanz bei den Schweinen (maximaler Inhalt des Futtertrogs von Mais/CCM) zwischen
  Seasons und AnimalsHUD. Die Troggröße wird von AnimalsHUD nur halb so groß ausgelesen. Der Ursprung des
  Fehlers könnte im LS (in Kombination mit Seasons) liegen.
  Abhilfe: Die angezeigte Größe des Mais/CCM-Trogs bei den Schweinen wurde im Code 'hart' korrigiert und in
  der Anzeige daher mit einem '*' versehen.

+++

Tastaturbelegung

Hinweis: Die Tastenfunktionen funktionieren nur außerhalb der Fahrzeuge.

Funktion                                     inputBinding.xml        empfohlene Tastenkombination

AnimalHUD: Hühner ein/aus                    KEY_lshift KEY_1        SHIFT + 1
AnimalHUD: Kühe ein/aus                      KEY_lshift KEY_2        SHIFT + 2
AnimalHUD: Schweine ein/aus                  KEY_lshift KEY_3        SHIFT + 3
AnimalHUD: Pferde ein/aus                    KEY_lshift KEY_4        SHIFT + 4
AnimalHUD: Schafe ein/aus                    KEY_lshift KEY_5        SHIFT + 5
AnimalHUD: Schrift kleiner                   KEY_lshift KEY_6        SHIFT + 6
AnimalHUD: Schrift größer                    KEY_lshift KEY_7        SHIFT + 7
AnimalHUD: Füllstände kombiniert ein/aus     KEY_lshift KEY_8        SHIFT + 8
AnimalHUD: Anzeige breit/schmal              KEY_lshift KEY_9        SHIFT + 9
AnimalHUD: Anzeige lang/kurz                 KEY_lshift KEY_0        SHIFT + 0
AnimalHUD: Anzeige ein/aus                   KEY_lshift KEY_minus    SHIFT + ß
AnimalHUD: Auswahl Tierbild                  KEY_lshift KEY_equals   SHIFT + ´ (links neben der Backspace-Taste [<---])

+++

Optimierung/Erweiterung der Spalten

Titelzeile
- Tierart
- dann folgt eine laufende Nummerierung der Ställe für jede Tierart
- danach steht eine Nummer; diese kennzeichnet beim Viehhändler die jeweilige Auswahl, denn dort sind die Ställe
  wild sortiert und man muss sonst rätseln, für welchen Stall man etwas kaufen will; Hühnerstall Nr. 7 ist beim
  Viehhändler also der 7. Stall ('(7) Hühner')
  Im Multiplayer-Spiel kann das sehr sinnvoll sein, um sich abzusprechen und Mißverständnisse zu vermeiden.

Spalte 1
- Anzeige der Produkte bzw. Fruchtarten
- die Zeichen '>' bzw. '<' kennzeichnen in der langen Darstellung zusammengehörige Fruchtarten
- Farbgebung: je nach Füllstand werden die Werte mit Farben grün, hellgrün, gelb und rot dargestellt;
  bei der alten Mod-Version wurden die Füllstände auch bei kombinierten Fruchtarten jeweils für jede
  einzelnd Fruchtart ausgewertet; Beispiel für 'Weizen oder Gerste': wenn nur Weizen zu 100% eingefüllt war
  wurde bei der Gerste ein Füllstand von 0% in rot angezeigt; das ist nicht korrekt, denn man kann ja gar
  keine Gerste mehr einfüllen; in der neuen Version wird in diesem fall beispielsweise auch Gerste in grün
  angezeigt und der Füllstand mit 100% angegeben, obwohl beispielsweise 0 Liter Gerste eingefüllt wurden

Spalte 2
- Anzeigewerte: aktuelle Erträge / Füllstande / Zustände (Sauberkeit und Produktivität)
- die Werte in Spalte 2 + 4 werden in der Kombiansicht jetzt auch auch wirklich kombiniert (die Farbe ist bei
  allen konsequenterweise Kombifrüchten gleich)

Spalte 3 (grau)
- Anzeigewerte: maximale Füllkapazität; auch bei kombinierten Fruchtarten korrekt angezeigt
- für das Beispiel 'Weizen oder Gerste': BEIDE Füllkapazitäten sind in der nicht-kombinierte Darstellung gleich,
  z.B. 1000 l; das bedeutet aber natürlich nur eine Gesamtkapazität von 1000 l und nicht 2 x 1000 l
  (eben Weizen ODER Gerste)

Spalte 4
- Anzeigewerte: die noch nachfüllbare Menge (für die Planung/Beladung)
- hier werden die Werte in grau dargestellt, wenn der Füllstand bereits größer als 90% ist (da nur kleine Mengen
  nachgefüllt werden könnten); ansonsten ist die Farbgebung entsprechend des Füllstands grün, hellgrün, gelb, rot
- die Werte in Spalte 2 + 4 werden in der Kombiansicht jetzt auch auch wirklich kombiniert (die Farbe ist bei
  allen konsequenterweise Kombifrüchten gleich)

+++

Anzeigemodi

Es gibt 3 Funktionen, die unabhängig ein- und ausgeschaltet werden können. Dadurch ergeben sich insgesamt 8 Anzeigemodi.

a) Füllstände kombiniert ein/aus
   - die Zeichen '>' bzw. '<' kennzeichnen in der langen Darstellung zusammengehörige Fruchtarten
   - die Erträge (weiß) werden in eine Zeile komprimiert
b) Anzeige breit/schmal
   - optionales Ausblenden der Spalte 3 und 4
c) Anzeige lang/kurz
   - optionales Ausblenden der Erzeugnisse/Produktivität (Reduktion auf die reinen Nachfüllmengen + Sauberkeit)

+++

Anzeige der Tiere

Mit einer zusätzlichen Tastenkombination lassen sich jetzt verschiedene Tiersymbole vor den Ställen einblenden. Der
Standard beim ersten Start ist 'Seasons-Tiersymbole, nicht transparent'.

Reihenfolge: 0 = aus, 1 = Seasons, 1 = Seasons farbig, 3 = Tiere freigestellt, 4 = Tierköpfe, 5 = Comic

Hinweis: Da die Symbole ggf. etwas zu aufdringlich sind werden diese bei jedem zweiten Durchlauf mit einer Transparenz
von 40% dargestellt. In der darauffolghende Runde ist die Transparenz dann wieder abgeschaltet und so weiter.

Das Ganze ist natürlich mit Variablen steuerbar (Zeile 34 bis 44).

+++

IDs der Fruchtarten und Erträge -> bitte den Hinweis unten zu MoreBunkSilo beachten

-- get language from giants engine for fruits and animals name
-- ID 2 = WEIZEN
-- ID 3 = GERSTE
-- ID 4 = HAFER
-- ID 5 = RAPS
-- ID 6 = SONNENBLUMEN
-- ID 7 = SOYABOHNEN
-- ID 8 = MAIS
-- ID 9 = KARTOFFEL
-- ID 10 = ZUCKERRÜBEN
-- ID 14 Pallets Chicken Eggs goes in game to 1?!
-- ID 15 Pallets Sheep wool goes in game to 1 !?!
-- ID 16 milk Cows
-- ID 18 = WASSER
-- ID 19 = MISCHRATION
-- ID 24 = SILAGE 
-- ID 28 = GRAS
-- ID 30 = HEU
-- ID 31 = STROH
-- ID 45 manure (mist) Cows, pigs
-- ID 46 liquid manure (gülle) Cows, pigs

MoreBunkSilo

Der Mod MoreBunkSilo bringt folgende Fruchtarten mit:
CCM (Schweine: als Futter zusätzlich zu Mais)
Grassilage (Kühe: als Futter zusätzlich zu Gras / Schafe: als Futter zusätzlich zu Gras und Heu)

MoreBunkerSilo erzeugt diese Futtertypen erst, wenn ein (neu gekaufter) Stall dies erfordert. Daher können die
notwendigen IDs dieser Futtertypen beim Start eines neuen Spiels noch nicht ermittelt werden.  

WICHTIG: Die IDs sind im Single- und Multiplayer-Spiel NICHT fest vergeben ! Daher müssen diese IDs beim Spielstart
explizit gemessen werden. Ist in dem Spiel bisher noch kein Scheinestall bzw. Kuh-/Schafstall gekauft worden kann die
ID zunächst nicht ermittelt werden.

Nach dem Kauf eines Stalls (Schweine, Kühe oder Schafe) berechnet AnimalsHUD automatisch beide IDs neu. Dies wird im
Log-File auch dokumentiert. Eine manuelle Neuberechnung der IDs wird ausgelöst, wenn man eine Stallart (Schweine, Kühe
oder Schafe) oder alle Ställe einmal aus- und wieder einblendet.

